home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / awup320.zip / ACTVIEW.DOC < prev    next >
Text File  |  1991-11-18  |  15KB  |  326 lines
  1.  ---------------------------------------------------------------------------
  2.                                ACTVIEW 3.2 (c)
  3.                     Wildcat! Activity Log Viewer/Analyzer
  4.                       Copyright (c) 1991 by Greg Wilson
  5.                              All Rights Reserved
  6.                                    11/18/91
  7.                              Author: Greg Wilson
  8.  ---------------------------------------------------------------------------
  9.  
  10.                                    Purpose
  11.                                    -------
  12.  Actview was written out of my own need for a tool to assist with reading
  13.  the activity log of my BBS. The task of viewing the log with a file viewer
  14.  was taking too long and I found myself rushing through the process,
  15.  missing many important events such as system ERRORs and invalid logon
  16.  attempts.
  17.  
  18.  Actview started as a simple program that produced a one line per call
  19.  report with a few flags. After getting input from some fellow sysops, I
  20.  decided to write a complete activity log viewer!
  21.  
  22.                                  Instructions
  23.                                  ------------
  24.  For a quick look at what Actview has to offer, copy ACTVIEW.EXE to the
  25.  directory containing your ACTIVITY.LOG's and run it. If you have more than
  26.  one node, you will have to build a file named ACTVIEW.CFG (see below). The
  27.  program will display the last recorded day's activity in a one line per call
  28.  format with the critical information shown. At the top of the screen, the
  29.  range of dates in the log is displayed along with the date of the information
  30.  being displayed. The primary Fkey functions are displayed at the bottom of
  31.  the screen. More functions are shown in the help window (F1). The calls can
  32.  be scrolled using the arrows, home, end, page up, and page down keys. If
  33.  enter is pressed, the detail of the highlighted call is extracted from the
  34.  activity log and displayed. Important events such as invalid logon attempts,
  35.  file overwrites, etc., are highlighted.
  36.  
  37.  
  38.  Key     Function
  39.  ------------------------------------------------------------------------
  40.  F1    - Displays the help window.
  41.  F2    - Swaps to another node's log. Directories to your different logs must
  42.          be entered in a file named ACTVIEW.CFG (see below).
  43.  F3    - Displays the following activity:
  44.          * Events
  45.          * Wildcat system errors such as files missing.
  46.          * Changes to the user's record such as changing birth dates,
  47.            passwords, ..etc.
  48.          * File overwrites.
  49.          * Invalid logon attempts. When detail is viewed for invalid logon
  50.            attempt, the next call is displayed for reference.
  51.          To return to the normal display, hit escape.
  52.  F4    - Displays totals for the currently displayed date.
  53.  F5    - Displays new users for the day showing their city and state.
  54.          To return to the normal display, hit escape.
  55.  F6    - Allows jumping directly to any date in the activity log.
  56.  F7    - Jumps to the previous day's activity.
  57.  F8    - Jumps to the next day's activity.
  58.  
  59.  F9    - Displays all calls of a specified user. The program will prompt for
  60.          user name, beginning date, and ending date of search. The name will
  61.          default to the highlighted call. The dates will default to the
  62.          beginning and end of the activity log. Actview will scan the log
  63.          finding all matching calls and then display the calls in the usual
  64.          one line per call format. To view totals for the user, hit F4. To
  65.          return to the normal display, hit Escape. To abort the search, press
  66.          the space bar.
  67.  F10 or ALT-X - Quits to DOS.
  68.  ALT-L - Toggles local calls. Local calls will not be displayed or
  69.          included in the daily counts.
  70.  ALT-S - Allows the entire activity log(s) to be searched for a given string
  71.          (such as filename, Message#, ..etc.). Here are some ways I use this
  72.          feature:
  73.          * Search for all activity related to a particular file.
  74.          * Search for all activity related to a bulletin or door.
  75.          * Find all users that still use XMODEM.
  76.          * See who is using TomCat.
  77.          * See who has exceeded their time limit.
  78.          * ...etc.!
  79.  ALT-D - View all downloads for the day.
  80.  ALT-U - View all uploads for the day with descriptions (if available).
  81.  ALT-O - Sort calls. Actview will display a menu of 7 different sort types.
  82.          This function also works while viewing downloads and uploads.
  83.  ALT-V - View all activity logs for all nodes. Every log in the ACTVIEW.CFG
  84.          file is scaned for the currently displayed date and the calls are
  85.          loaded. This is a major time saver!
  86.  
  87.  
  88.  A typical Actview session would go something like:
  89.  
  90.       * Type ACTVIEW (if multi-node use the VIRT parameter to load all logs).
  91.       * Hit F3; if any errors are displayed, view the detail.
  92.       * Hit F5; view new users.
  93.       * Hit ALT-U to see what was uploaded.
  94.       * Hit ALT-D to see what was downloaded.
  95.       * Hit ESC to go back to viewing all calls.
  96.       * Scroll though the summary looking for uploads, msgs, carrier
  97.         drops and pages viewing the detail of these activities if desired.
  98.  
  99.  An average review takes me about 2 minutes compared to 20 minutes before
  100.  I had ACTVIEW!
  101.  
  102.                               User Defined Flags
  103.                               ------------------
  104.  
  105.  Actview allows sysops to define flags to indicate that a certain activity
  106.  has occured during a call. These one character flags are displayed on the
  107.  initial call summary screen and are defined in the file ACTVIEW.FLG. This has
  108.  many uses including:
  109.  
  110.                 * Flag all users that download a certain file
  111.                 * Flag all users that use a certain door
  112.                 * Flag all users that drop carrier
  113.                 * Flag all users that exceed their download ratio
  114.                 * Flag all users that leave a message in a certain folder
  115.                 * Flag all users that complete a certain questionnaire
  116.                 * .. etc.
  117.  
  118.  A flag is a single character to be displayed in the flag column on the
  119.  summary screen. Up to 5 flags can be displayed for a single call. If more
  120.  than 5 flags are found, the last flag will be then character "*". Also, when
  121.  viewing the detail of a call, any lines that contain the flag string will be
  122.  highlighted. In the ACTVIEW.FLG file, the first column contains the flag
  123.  character to be displayed. The string to turn on the flag is enclosed in
  124.  quotes on the same line as the flag character.
  125.  
  126.  Example: If an additional flag was desired to show any activity related to
  127.  the file "FILELIST.ZIP", ACTVIEW.FLG would be updated as follows (remember
  128.  that the flag characters must be in column 1):
  129.  
  130.                                E "ERROR"
  131.                                C "DROPPING CARRIER"
  132.                                D "OVER DOWNLOAD RATIO"
  133.                                M "MNP:YES"
  134.                                F "FILELIST.ZIP"
  135.                                V "ACTVIEW.ZIP"
  136.  
  137.                      ***    Note: Case is ignored    ***
  138.  
  139.  See the file ACTVIEW.FLG for more examples. The initial flags for dropping
  140.  carrier, errors, new users, and exceeding download ratio are already set up.
  141.  
  142.  
  143.  
  144.  
  145.                              Multi Node Features
  146.                              -------------------
  147.  
  148.  For multi-node operation, create a file named ACTVIEW.CFG with the
  149.  directories and filenames in the following format: (in column 1)
  150.  
  151.                              C:\WC30\ACTIVITY.001
  152.                              C:\WC30\ACTIVITY.002
  153.                              C:\WC30\ACTIVITY.003
  154.                              C:\WC30\ACTIVITY.004
  155.  
  156.  The entire path *and* filename must be specified in each line.
  157.  
  158.  NOTE: ACTVIEW.CFG must be in the same directory as ACTVIEW.EXE
  159.  
  160.  This feature may also be useful for single node sysops that maintain
  161.  backup copies of their logs under other names and/or directories and still
  162.  want to access them via Actview.
  163.  
  164.  NOTE: Actview only opens the ACTIVITY.LOG when needed and closed the file
  165.  during all other activities therefore allowing Wildcat to keep writing to the
  166.  log without any type of share violation. This greatly increases the
  167.  reliability of Actview when using on a log that is currently active. This
  168.  also gives the ability to view the current callers activity to see what
  169.  he/she just did.
  170.  
  171.  
  172.  
  173.                               Actview parameters
  174.                               ------------------
  175.  
  176.           ACTVIEW mm/dd/yy NOLocal ERRors NEW NODE=x MONO SNOW BIOS
  177.  
  178.             mm/dd/yy - Go directly to mm/dd/yy.
  179.             HELP     - Display help screen.
  180.             NOLocal  - Do not show local calls (ALT-L toggles).
  181.             ERRors   - Show errors for the day (F3 toggles).
  182.             NEW      - Show new users only (F5 toggles).
  183.             NODE=x   - Go to node x. ACTVIEW.CFG must be present.
  184.             MONO     - Force monochrome attributes.
  185.             NOMOUSE  - Turn Off Mouse support (speeds up entry and exit).
  186.             SNOW     - Turn on snow checking during screen writes.
  187.             VIRT     - View all nodes at once (ACTVIEW.CFG required).
  188.             BIOS     - Use bios screen writes. This option is not necessary
  189.                        when running Actview under Desqview because checks for
  190.                        Desqview are made and direct screen writes are
  191.                        re-mapped accordingly. BIOS writes are much slower than
  192.                        the normal direct screen writes and should not be used
  193.                        unless necessary.
  194.             LARGE    - Use large jump values during searches. This parameter
  195.                        is normally not needed unless some of the calls in the
  196.                        activity logs exceed 100 lines (usually netmail hubs).
  197.                        If Actview sometimes hangs, try this parameter. It is
  198.                        not the size of the actual activity log file but the
  199.                        size of the individual calls within the log. See
  200.                        MAJ/MIN/MAX paramters to fine tune Actview (only try if
  201.                        having problems)
  202.  
  203.  
  204.  
  205.                            Requirements and Limits
  206.                            -----------------------
  207.  * ACTVIEW has been tested with the activity logs created by Wildcat 3.01,
  208.    3.0, 2.55, 2.50, 2.15, 2.0 and the Wildcat Test Drive!
  209.  
  210.  * ACTVIEW is Desqview aware. No extra parameters are needed.
  211.  
  212.                       Memory requirements: 220k (Multi node see note)
  213.                  Max nodes in ACTVIEW.CFG: 100
  214.                                 Max flags: 100
  215.  
  216.   Max number of displayed calls is now only limited by the available memory.
  217.   The max number is displayed in the help window. This is also the max number
  218.   of hits when searching (ALT-S or F9). If the search finds more than the
  219.   available number of displayed calls, a message will be displayed and the
  220.   search will be halted.
  221.  
  222.   Multi-node note: If your BBS receives a lot of calls each day, more memory
  223.   will be needed to view the calls. With 180k, only about 400 calls per day
  224.   are allowed to be viewed at once. The max number of calls is displayed in
  225.   the help window.
  226.  
  227.  * Actview opens the ACTIVITY.LOG's in READ ONLY mode. *No* writes are made to
  228.    *any* files.
  229.  
  230.                                   Liability
  231.                                   ---------
  232.  
  233.  Actview has been tested on multiple machines using many different
  234.  configurations and no problems have occured. However, if a problem does arise
  235.  due to Actview, I cannot be held responsible. Use at your own risk.
  236.  
  237.  
  238.  
  239.                         Distribution and Registration
  240.                         -----------------------------
  241.  
  242.  Actview may be freely distributed only as the following unaltered files:
  243.  
  244.                                  ACTVIEW.EXE
  245.                                  ACTVIEW.FLG
  246.                                  ACTVIEW.DOC
  247.                                  ACTVIEW.HIS
  248.                                  READ.ME
  249.                                  REGISTER.DOC
  250.  
  251.  ACTVIEW is  not free. You must register after the 30-day evaluation time
  252.  period.
  253.  
  254.  ACTVIEW is a Shareware product.  It is distributed through public access
  255.  channels so that perspective buyers can have the opportunity to evaluate the
  256.  product before making a  decision to buy. If you decide to use this software,
  257.  then you are under both legal and moral obligation to register it with the
  258.  author. But if you decide not to use it after evaluating the software, you
  259.  are under no obligation. It is fully protected by State, Federal and
  260.  International copyright laws.
  261.  
  262.  If you continue to use ACTVIEW after the 30-day evaluation time period you
  263.  must register it.
  264.  
  265.                             Registration Fee  : $25 US
  266.  
  267.  Why Register?
  268.  --------------------------------------------------------------------
  269.  * All opening and closing screens are removed!
  270.  * Registered users have access to the Actview support BBS is granted!
  271.  * All Actview reports can be downloaded from the support BBS!
  272.  * All future updates are free!
  273.  
  274.  To register ACTVIEW, complete in the order form (REGISTER.DOC) and mail along
  275.  with your check or money order payable to "Greg Wilson" to:
  276.  
  277.                           Greg Wilson
  278.                           1427 Valley Lake Dr. #1228
  279.                           Schaumburg, Il 60195
  280.  
  281.  ██████████████████████████████████████████████████████████████████████████████
  282.                 * Credit Card Orders (VISA/MC/Discover/Amex) *
  283.  ██████████████████████████████████████████████████████████████████████████████
  284.  
  285.          Visa/MC/Amex/Discover (via the Public Software Library):
  286.  
  287.                         1-800-2424-PSL or 713-524-6394
  288.                         FAX: 1-713-524-6398
  289.                         CIS Email: 71355,470
  290.  
  291.                                 Product #10407
  292.  
  293.                     Credit card Price is $15 + $3 handling
  294.  
  295.                       THESE NUMBERS ARE FOR ORDERS ONLY!
  296.  
  297.                Do not call these numbers for technical support!
  298.  
  299.       All orders are relayed back to me the same day the order is made.
  300.  
  301.     The registered version can be shipped, uploaded or downloaded from my
  302.                             BBS or via CompuServe.
  303.  
  304.  ██████████████████████████████████████████████████████████████████████████████
  305.  
  306.  
  307.  
  308.  
  309.                             Contacting the Author
  310.                             ---------------------
  311.  
  312.  I can be reached for comments, questions, suggestions, complaints, etc., at
  313.  the following EMAIL boxes:
  314.  
  315.  
  316.           My BBS            (SYSOP)            - mail checked daily
  317.           Mustang BBS       (GREG WILSON)      - mail checked daily
  318.           CompuServe        (76547,3106)       - mail checked daily
  319.           EXEC-PC           (GREGORY WILSON)   - mail checked daily
  320.           Channel 1         (GREG WILSON)      - mail checked daily
  321.           PC-Ohio           (GREG WILSON)      - mail checked daily
  322.           Executive Network (GREG WILSON)      - mail checked daily
  323.  
  324.  
  325.                                     -end-
  326.